package Game;
/**
 * HealthState.java
 * 
 * The enumerated types below list all the possible health states for a character
 * or donkey or other object that has a health state. A health state provides
 * additional information to the integer health. 
 *
 * @author Ray DeCuir
 * @version 1.0
 */
public enum HealthState {
	
	// possible health states 
	DEAD(0),        
	SICKLY(1),      
	EXHAUSTED(2),   
	TIRED(3),       
	NORMAL(4),      
	HEALTHY(5);

	// index of the health state in the array HealthState.values()
	private int index;
	
	/**
	 * Enumerated constructor for the HealthState object
	 * 
	 * @param index The index of the healthstate
	 */
	private HealthState(int index)
	{
		this.index = index;
	}
	
	/**
	 * Gets the index for the state
	 * 
	 * @return The index of the HealthState
	 */
	public int getIndex() {
		return index;
	}   
	
}
